home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Mail / pine3.92 / pico / estruct.h < prev    next >
C/C++ Source or Header  |  1996-03-14  |  13KB  |  319 lines
  1. /*
  2.  * $Id: estruct.h,v 4.27 1996/03/15 07:41:11 hubert Exp $
  3.  *
  4.  * Program:    Struct and preprocessor definitions
  5.  *
  6.  *
  7.  * Michael Seibel
  8.  * Networks and Distributed Computing
  9.  * Computing and Communications
  10.  * University of Washington
  11.  * Administration Builiding, AG-44
  12.  * Seattle, Washington, 98195, USA
  13.  * Internet: mikes@cac.washington.edu
  14.  *
  15.  * Please address all bugs and comments to "pine-bugs@cac.washington.edu"
  16.  *
  17.  *
  18.  * Pine and Pico are registered trademarks of the University of Washington.
  19.  * No commercial use of these trademarks may be made without prior written
  20.  * permission of the University of Washington.
  21.  * 
  22.  * Pine, Pico, and Pilot software and its included text are Copyright
  23.  * 1989-1996 by the University of Washington.
  24.  * 
  25.  * The full text of our legal notices is contained in the file called
  26.  * CPYRIGHT, included with this distribution.
  27.  *
  28.  */
  29. /*    ESTRUCT:    Structure and preprocesser defined for
  30.             MicroEMACS 3.6
  31.  
  32.             written by Dave G. Conroy
  33.             modified by Steve Wilhite, George Jones
  34.             greatly modified by Daniel Lawrence
  35. */
  36.  
  37. #ifndef    ESTRUCT_H
  38. #define    ESTRUCT_H
  39.  
  40. /*    Configuration options    */
  41.  
  42. #define CVMVAS  1    /* arguments to page forward/back in pages    */
  43. #define    NFWORD    1    /* forward word jumps to begining of word    */
  44. #define    TYPEAH    0    /* type ahead causes update to be skipped    */
  45. #define    REVSTA    1    /* Status line appears in reverse video        */
  46.  
  47.  
  48. /*    internal constants    */
  49.  
  50. #define    NBINDS    50            /* max # of bound keys        */
  51. #define NFILEN  80                      /* # of bytes, file name        */
  52. #define NBUFN   16                      /* # of bytes, buffer name      */
  53. #define NLINE   256                     /* # of bytes, line             */
  54. #define    NSTRING    256            /* # of bytes, string buffers    */
  55. #define NPAT    80                      /* # of bytes, pattern          */
  56. #undef    HUGE
  57. #define HUGE    1000                    /* Huge number                  */
  58. #define    NLOCKS    100            /* max # of file locks active    */
  59.  
  60. #define AGRAVE  0x60                    /* M- prefix,   Grave (LK201)   */
  61. #define METACH  0x1B                    /* M- prefix,   Control-[, ESC  */
  62. #define CTMECH  0x1C                    /* C-M- prefix, Control-\       */
  63. #define EXITCH  0x1D                    /* Exit level,  Control-]       */
  64. #define CTRLCH  0x1E                    /* C- prefix,   Control-^       */
  65. #define HELPCH  0x1F                    /* Help key,    Control-_       */
  66.  
  67. #undef  CTRL
  68. #define CTRL    0x0100                  /* Control flag, or'ed in       */
  69. #define META    0x0200                  /* Meta flag, or'ed in          */
  70. #define CTLX    0x0400                  /* ^X flag, or'ed in            */
  71. #define    SPEC    0x0800            /* special key (arrow's, etc)    */
  72. #define    FUNC    0x1000            /* special key (function keys)    */
  73. #if    MSDOS || defined(OS2)
  74. #define    SHFT    0x2000            /* shifted (for function keys)    */
  75. #define    ALTD    0x4000            /* ALT key...            */
  76. #endif
  77.  
  78. #define    QNORML    0x0000            /* Flag meaning no flag ;)    */
  79. #define    QFFILE    0x0001            /* Flag buffer for file neme    */
  80. #define    QDEFLT    0x0002            /* Flag to use default answer    */
  81. #define    QBOBUF    0x0004            /* Start with cursor at BOL    */
  82.  
  83. #undef    FALSE
  84. #define FALSE   0                       /* False, no, bad, etc.         */
  85. #undef    TRUE
  86. #define TRUE    1                       /* True, yes, good, etc.        */
  87. #define ABORT   2                       /* Death, ^G, abort, etc.       */
  88.  
  89. #define FIOSUC  0                       /* File I/O, success.           */
  90. #define FIOFNF  1                       /* File I/O, file not found.    */
  91. #define FIOEOF  2                       /* File I/O, end of file.       */
  92. #define FIOERR  3                       /* File I/O, error.             */
  93. #define    FIOLNG    4            /*line longer than allowed len    */
  94. #define    FIODIR    5            /* File is a directory        */
  95. #define    FIONWT    6            /* File lacks write permission    */
  96. #define    FIONRD    7            /* File lacks read permission    */
  97. #define    FIONEX    8            /* File lacks exec permission    */
  98. #define    FIOSYM    9            /* File is a symbolic link    */
  99. #define    FIOPER    10            /* Generic permission denied    */
  100.  
  101.  
  102. #define CFCPCN  0x0001                  /* Last command was C-P, C-N    */
  103. #define CFKILL  0x0002                  /* Last command was a kill      */
  104. #define CFFILL  0x0004                  /* Last command was a kill      */
  105.  
  106. #define    BELL    0x07            /* a bell character        */
  107. #define    TAB    0x09            /* a tab character        */
  108.  
  109.  
  110. /*
  111.  * macros to help filter character input
  112.  */
  113. #if defined(DOS) || defined(OS2)
  114. #define    HIBIT_FIRST    (0x7f)
  115. #else
  116. #define    HIBIT_FIRST    (0x9f)
  117. #endif /* DOS */
  118. #define    LOBIT_CHAR(C)    ((C) > 0x1f && (C) < 0x7f)
  119. #define    HIBIT_CHAR(C)    ((C) > HIBIT_FIRST && (C) <= 0xff)
  120. #define    HIBIT_OK(C)    (!(gmode & MDHBTIGN) && ((C) & 0x80))
  121. #define    VALID_KEY(C)    (LOBIT_CHAR(C) || (HIBIT_OK(C) && HIBIT_CHAR(C)))
  122.  
  123.  
  124. /*
  125.  * Definitions for varisous port-specific keymenu data
  126.  */
  127. #ifndef    KS_OSDATAVAR
  128. #define    KS_OSDATAVAR
  129. #define    KS_OSDATAGET(X)
  130. #define    KS_OSDATASET(X, Y)
  131.  
  132. #define    KS_NONE
  133. #define    KS_SCREENHELP
  134. #define    KS_PREVPAGE
  135. #define    KS_NEXTPAGE
  136. #define    KS_SEND
  137. #define    KS_RICHHDR
  138. #define    KS_CURPOSITION
  139. #define    KS_POSTPONE
  140. #define    KS_CANCEL
  141. #define    KS_ATTACH
  142. #define    KS_SAVEFILE
  143. #define    KS_READFILE
  144. #define    KS_EXIT
  145. #define    KS_JUSTIFY
  146. #define    KS_WHEREIS
  147. #define    KS_SEND
  148. #define    KS_ALTEDITOR
  149. #define    KS_SPELLCHK
  150. #endif
  151.  
  152.  
  153. /*
  154.  * There is a window structure allocated for every active display window. The
  155.  * windows are kept in a big list, in top to bottom screen order, with the
  156.  * listhead at "wheadp". Each window contains its own values of dot and mark.
  157.  * The flag field contains some bits that are set by commands to guide
  158.  * redisplay; although this is a bit of a compromise in terms of decoupling,
  159.  * the full blown redisplay is just too expensive to run for every input
  160.  * character.
  161.  */
  162. typedef struct  WINDOW {
  163.         struct  WINDOW *w_wndp;         /* Next window                  */
  164.         struct  BUFFER *w_bufp;         /* Buffer displayed in window   */
  165.         struct  LINE *w_linep;          /* Top line in the window       */
  166.         struct  LINE *w_dotp;           /* Line containing "."          */
  167.         short   w_doto;                 /* Byte offset for "."          */
  168.         struct  LINE *w_markp;          /* Line containing "mark"       */
  169.         short   w_marko;                /* Byte offset for "mark"       */
  170.         struct  LINE *w_imarkp;         /* INTERNAL Line with "mark"    */
  171.         short   w_imarko;               /* INTERNAL "mark" byte offset  */
  172.         char    w_toprow;               /* Origin 0 top row of window   */
  173.         char    w_ntrows;               /* # of rows of text in window  */
  174.         char    w_force;                /* If NZ, forcing row.          */
  175.         char    w_flag;                 /* Flags.                       */
  176. }       WINDOW;
  177.  
  178. #define WFFORCE 0x01                    /* Window needs forced reframe  */
  179. #define WFMOVE  0x02                    /* Movement from line to line   */
  180. #define WFEDIT  0x04                    /* Editing within a line        */
  181. #define WFHARD  0x08                    /* Better to a full display     */
  182. #define WFMODE  0x10                    /* Update mode line.            */
  183.  
  184. /*
  185.  * Text is kept in buffers. A buffer header, described below, exists for every
  186.  * buffer in the system. The buffers are kept in a big list, so that commands
  187.  * that search for a buffer by name can find the buffer header. There is a
  188.  * safe store for the dot and mark in the header, but this is only valid if
  189.  * the buffer is not being displayed (that is, if "b_nwnd" is 0). The text for
  190.  * the buffer is kept in a circularly linked list of lines, with a pointer to
  191.  * the header line in "b_linep".
  192.  *     Buffers may be "Inactive" which means the files accosiated with them
  193.  * have not been read in yet. These get read in at "use buffer" time.
  194.  */
  195. typedef struct  BUFFER {
  196.     struct  BUFFER *b_bufp;         /* Link to next BUFFER          */
  197.     struct  LINE *b_dotp;           /* Link to "." LINE structure   */
  198.     short   b_doto;                 /* Offset of "." in above LINE  */
  199.     struct  LINE *b_markp;          /* The same as the above two,   */
  200.     short   b_marko;                /* but for the "mark"           */
  201.     struct  LINE *b_linep;          /* Link to the header LINE      */
  202.     long    b_linecnt;        /* Lines in buffer (mswin only)    */
  203.     long    b_mode;            /* editor mode of this buffer    */
  204.     char    b_active;        /* window activated flag    */
  205.     char    b_nwnd;                 /* Count of windows on buffer   */
  206.     char    b_flag;                 /* Flags                        */
  207.     char    b_fname[NFILEN];        /* File name                    */
  208.     char    b_bname[NBUFN];         /* Buffer name                  */
  209. }    BUFFER;
  210.  
  211. #define BFTEMP     0x01                    /* Internal temporary buffer     */
  212. #define BFCHG      0x02                    /* Changed since last write      */
  213. #define BFWRAPOPEN 0x04                    /* Wordwrap should open new line */
  214.  
  215.  
  216. /*
  217.  * The starting position of a region, and the size of the region in
  218.  * characters, is kept in a region structure.  Used by the region commands.
  219.  */
  220. typedef struct  {
  221.         struct  LINE *r_linep;          /* Origin LINE address.         */
  222.         short   r_offset;               /* Origin LINE offset.          */
  223.         long    r_size;                 /* Length in characters.        */
  224. }       REGION;
  225.  
  226.  
  227. /*
  228.  * character and attribute pair.  The basic building block
  229.  * of the editor.  The bitfields may have to be changed to a char
  230.  * and short if there are problems...
  231.  */
  232. typedef    struct CELL {
  233.     unsigned int c : 8;        /* Character value in cell      */
  234.     unsigned int a : 8;        /* Its attributes               */
  235. } CELL;
  236.  
  237.  
  238. /*
  239.  * All text is kept in circularly linked lists of "LINE" structures. These
  240.  * begin at the header line (which is the blank line beyond the end of the
  241.  * buffer). This line is pointed to by the "BUFFER". Each line contains a the
  242.  * number of bytes in the line (the "used" size), the size of the text array,
  243.  * and the text. The end of line is not stored as a byte; it's implied. Future
  244.  * additions will include update hints, and a list of marks into the line.
  245.  */
  246. typedef struct  LINE {
  247.         struct  LINE *l_fp;             /* Link to the next line        */
  248.         struct  LINE *l_bp;             /* Link to the previous line    */
  249.         short   l_size;                 /* Allocated size               */
  250.         short   l_used;                 /* Used size                    */
  251.         CELL    l_text[1];              /* A bunch of characters.       */
  252. }       LINE;
  253.  
  254. #define lforw(lp)       ((lp)->l_fp)
  255. #define lback(lp)       ((lp)->l_bp)
  256. #define lgetc(lp, n)    ((lp)->l_text[(n)])
  257. #define lputc(lp, n, c) ((lp)->l_text[(n)]=(c))
  258. #define llength(lp)     ((lp)->l_used)
  259.  
  260. /*
  261.  * The editor communicates with the display using a high level interface. A
  262.  * "TERM" structure holds useful variables, and indirect pointers to routines
  263.  * that do useful operations. The low level get and put routines are here too.
  264.  * This lets a terminal, in addition to having non standard commands, have
  265.  * funny get and put character code too. The calls might get changed to
  266.  * "termp->t_field" style in the future, to make it possible to run more than
  267.  * one terminal type.
  268.  */
  269. typedef struct  {
  270.         short   t_nrow;                 /* Number of rows - 1.          */
  271.         short   t_ncol;                 /* Number of columns.           */
  272.     short    t_margin;        /* min margin for extended lines*/
  273.     short    t_scrsiz;        /* size of scroll region "    */
  274.         short   t_mrow;                 /* Number of rows in menu       */
  275.         int     (*t_open)();            /* Open terminal at the start.  */
  276.         int     (*t_close)();           /* Close terminal at end.       */
  277.         int     (*t_getchar)();         /* Get character from keyboard. */
  278.         int     (*t_putchar)();         /* Put character to display.    */
  279.         int     (*t_flush)();           /* Flush output buffers.        */
  280.         int     (*t_move)();            /* Move the cursor, origin 0.   */
  281.         int     (*t_eeol)();            /* Erase to end of line.        */
  282.         int     (*t_eeop)();            /* Erase to end of page.        */
  283.         int     (*t_beep)();            /* Beep.                        */
  284.     int    (*t_rev)();        /* set reverse video state    */
  285. }       TERM;
  286.  
  287. /*    structure for the table of initial key bindings        */
  288.  
  289. typedef struct  {
  290.         short   k_code;                 /* Key code                     */
  291.         int     (*k_fp)();              /* Routine to handle it         */
  292. }       KEYTAB;
  293.  
  294. /*      sturcture used for key menu painting         */
  295.  
  296. typedef struct {
  297.     char    *name;            /* key to display          */
  298.     char    *label;            /* function name key envokes    */
  299.     KS_OSDATAVAR            /* port-specific data */
  300. }    KEYMENU;
  301.  
  302. typedef struct {
  303.     char    *name;            /* key to display          */
  304.     char    *label;            /* function name key envokes    */
  305.     int    key;            /* what to watch for and return    */
  306.     KS_OSDATAVAR            /* port-specific data */
  307. }    EXTRAKEYS;
  308.  
  309. #ifdef    MOUSE
  310.  
  311. /* Test if mouse position (R, C) is in menu item (X) */
  312. #define    M_ACTIVE(R, C, X)    (((unsigned)(R)) >= (X)->tl.r       \
  313.                     && ((unsigned)(R)) <= (X)->br.r \
  314.                     && ((unsigned)(C)) >= (X)->tl.c \
  315.                     && ((unsigned)(C)) < (X)->br.c)
  316. #endif    /* MOUSE */
  317.  
  318. #endif    /* ESTRUCT_H */
  319.